/*
 * gybon - Core modules for Google Yahoo Rich Application Framework
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 0.2.0
 */
package gyraf.wrapper.client.logger;

import gyraf.wrapper.client.JsConfiguration;

/**
 * Configuration object for YuiLogReader
 */
public class LogReaderData extends JsConfiguration {

	public LogReaderData() {
		super();
	}

	/**
	 * Whether or not output is verbose (more readable). Setting to true will
	 * make output more compact (less readable). Default true!
	 * 
	 * @param val
	 *            false to disabled verbose mode.
	 * @return this object
	 */
	public LogReaderData setVerboseOutput(boolean val) {
		setProp("verboseOutput", val);
		return this;
	}

	/**
	 * Whether or not the footer UI is enabled for the LogReader. Default true.
	 * 
	 * @param val
	 *            false to disabled footer.
	 * @return this object
	 */
	public LogReaderData setFooterEnabled(boolean val) {
		setProp("footerEnabled", val);
		return this;
	}

	/**
	 * Whether or not newest message is printed on top.
	 * 
	 * @param val
	 *            true to have newest message on top.
	 * @return this object
	 */
	public LogReaderData setNewestOnTop(boolean val) {
		setProp("newestOnTop", val);
		return this;
	}

	/**
	 * Enables LogReader to be dragged if DragDrop Utility is present. Default
	 * true.
	 * 
	 * @param val
	 *            true to allow the reader to be dragged.
	 * @return this object
	 */
	public LogReaderData setDraggable(boolean val) {
		setProp("draggable", val);
		return this;
	}

	/**
	 * Maximum number of messages a LogReader console will display. Default 500.
	 * 
	 * @param val
	 *            the maximum number of messages.
	 * @return this object
	 */
	public LogReaderData setMaxMessage(int val) {
		setProp("thresholdMax", val);
		return this;
	}

	/**
	 * When a LogReader console reaches its thresholdMax, it will clear out
	 * messages and print out the latest thresholdMin number of messages..
	 * Default 100.
	 * 
	 * @param val
	 *            the minimum number of messages.
	 * @return this object
	 */
	public LogReaderData setMinMessage(int val) {
		setProp("thresholdMin", val);
		return this;
	}

	/**
	 * Set the title of the log reader
	 * 
	 * @param val
	 *            the log reader title
	 * @return this object
	 */
	public LogReaderData setMinMessage(String val) {
		setProp("title", val);
		return this;
	}

}
